Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

openapi3: reference originating locations in YAML specs - step 1 #1007

Merged
merged 46 commits into from
Oct 21, 2024
Merged

openapi3: reference originating locations in YAML specs - step 1 #1007

merged 46 commits into from
Oct 21, 2024

Conversation

reuvenharrison
Copy link
Contributor

@reuvenharrison reuvenharrison commented Aug 25, 2024 •
edited
Loading

This PR adds the ability to correlate OpenAPI components with the location in the originating YAML spec.
Here's a summary of the changes required to achieve this:

  1. Modify yaml.v3 to add line and column numbers of each YAML element to the unmarshaled interfaces (see https://github.com/oasdiff/yaml3)
  2. Modify invopop/yaml with a new function: UnmarshalWithOrigin (see https://github.com/oasdiff/yaml)
  3. Modify this repo to add an Origin struct to OpenAPI components. This requires changes to the UnmarshalJSON functions and, in some cases, replacing native types, like map[string]string, by dedicated types that include the original native type and an Origin member.

This PR addresses issue #986

Follow up tasks to be addressed by future PRs:

  • Add origin to more elements, namely Components and some types that are unmarshalled with unmarshalStringMapP or unmarshalStringMap
  • Merge changes in yaml.v3 and invopop/yaml back to original repos and remove replace directives from go.mod
  • Enhance origin to include end line and column and YAML comments as proposed by @fenollp

@reuvenharrison
add origin - step 1
20a9abd
@reuvenharrison
delete origin from content
f90371a
@reuvenharrison
point to Origin
7d41bd0
@reuvenharrison
make include origin configurable
77f909b
@reuvenharrison
generic unmarshalStringMap
15e7cab
@reuvenharrison
add origin to more components
450e4d0
@reuvenharrison
revert comments
6b52b19
@reuvenharrison
use const originKey
775ab17
@reuvenharrison
comment to Scopes
d241445
@reuvenharrison
test more specs
206c1be
@reuvenharrison
Fix Discriminator
032ff76
@reuvenharrison
update docs
4304772
@reuvenharrison
test on a decent set of dedicated specs
67ee9fa
@reuvenharrison
remove trainling spaces
8095459
@reuvenharrison
add comments
d24b68a
@reuvenharrison
remove trailing whitespace
c5cf284
@reuvenharrison
update docs
98ace80
@reuvenharrison
dedicated tests
c981f30
@reuvenharrison
update docs
6daf324
@reuvenharrison
remove whitespace
17db6ab
@reuvenharrison
rm empty line
015b63e
@reuvenharrison
rm last newline
34f95b7
@reuvenharrison
add tests
020e44b
@reuvenharrison
rm unused test files
07a3b25
@reuvenharrison
update deps
cba19cf
@reuvenharrison
fix paths test
2d5e393
@reuvenharrison
test components/security
b9f7dd6
@reuvenharrison
fix LF
aa8c5b1
@reuvenharrison
include origin in unmarshal maps
8a00ba0
@reuvenharrison reuvenharrison marked this pull request as ready for review September 21, 2024 07:56
@reuvenharrison reuvenharrison changed the title Correlate OpenAPI components with their location in the originating YAML spec Add reference to originating locations in YAML specs - step 1 Sep 21, 2024
fenollp
fenollp requested changes Oct 8, 2024
View reviewed changes
Copy link
Collaborator

@fenollp fenollp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor edits otherwise LGTM

openapi3/components.go Outdated Show resolved Hide resolved
openapi3/discriminator.go Outdated Show resolved Hide resolved
openapi3/security_scheme.go Outdated Show resolved Hide resolved
@reuvenharrison reuvenharrison mentioned this pull request Oct 14, 2024
Merged
Jille and others added 7 commits October 16, 2024 13:58
@Jille @fenollp @reuvenharrison
Add github.com/pb33f/libopenapi (#1004)
929edf0 
* Add github.com/pb33f/libopenapi

it looks like a reasonable alternative

* Update README.md

---------

Co-authored-by: Pierre Fenoll <pierrefenoll@gmail.com>
@alexbakker @reuvenharrison
Introduce an option to override the regex implementation (#1006)
d2c2b3c
@jlsherrill @reuvenharrison
make form required field order deterministic (#1008)
0125b1b
@reversearrow @reuvenharrison
openapi2: fix un/marshalling discriminator field (#1011)
45f4435 
* fix: issue unmarshalling when discriminator field is set in openapi2.0

* revert original approach

* update with different approach

* Revert "update with different approach"

This reverts commit 2db2b39.

* v2 schema with discriminator field set as string

* update ref link and comment

* run docs.sh
@EwenQuim @reuvenharrison
README: add Fuego to dependents (#1017)
cfdf905
@fenollp @reuvenharrison
openapi3: skip a test in CI to avoid 403s from some remote server (#1019
dd25946 
)

Signed-off-by: Pierre Fenoll <pierrefenoll@gmail.com>
@reuvenharrison
revert fix test (json-schema 301)
8113413
@fenollp fenollp changed the title Add reference to originating locations in YAML specs - step 1 openapi3: reference originating locations in YAML specs - step 1 Oct 21, 2024
@fenollp fenollp merged commit c333b34 into getkin:master Oct 21, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fenollp fenollp fenollp approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@reuvenharrison @fenollp @Jille @alexbakker @jlsherrill @reversearrow @EwenQuim